home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_200 / 295_01 / manx.rme < prev    next >
Encoding:
Text File  |  1989-12-28  |  6.9 KB  |  261 lines
  1. ----------------------------------------------------------------------
  2. | Citadel                                                            |
  3. | 241 East Eleventh Street * Brookville, IN 47012 * 317-647-4720     |
  4. |                                               BBS 317-647-2403     |
  5. ----------------------------------------------------------------------
  6.  
  7. manx is distributed in a single compressed file manxRL.zip; R and L
  8. would be the release and level numbers, respectively.  The ZIP data
  9. compression utilities are needed to extract the individual files.
  10.  
  11. The following files are obtained by decompressing manxRL.zip:
  12.  
  13.     manx.rme  preliminary information
  14.     manx.c    manx source code
  15.     manx.frm  manual entry form
  16.  
  17. The original file manxRL.zip should be saved if you wish to pass on
  18. copies of manx.  Please do not distribute manx as individual files,
  19. or in an incomplete or altered form.
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.                                                         Citadel  89-10
  53. ----------------------------------------------------------------------
  54. | manx - manual entry extractor                                      |
  55. | Version 1.1                                                        |
  56. ----------------------------------------------------------------------
  57.  
  58. MANX
  59.  
  60. The manx utility extracts manual entries from source files.  The files
  61. are read from stdin and the manual entries are written to stdout.
  62. Each individual manual entry is broken into pages separated by form
  63. feeds and terminated with a form feed.  The manx manual entry located
  64. in manx.c contains a more detailed description.  For additional
  65. information on manx, see the article "manx - A Tool for Function
  66. Documentation," which will appear in a future issue of "COMPUTER
  67. LANGUAGE."
  68.  
  69. The manx utility was written for cbase, a C database library developed
  70. at Citadel.  The current version of cbase as well as manx can be
  71. downloaded from the Citadel BBS 317-647-2403.
  72.  
  73. ======================================================================
  74. COPYRIGHT
  75.  
  76. Copyright (c) 1989 Citadel.
  77.  
  78. The manx utility has been released into the public domain, and so may
  79. be copied freely.  It is requested, however, that manx not be
  80. distributed in an incomplete or altered form.
  81.  
  82. ======================================================================
  83. DISCLAIMER
  84.      Citadel hereby disclaims all warranties relating to this
  85.      software, whether express or implied, including without
  86.      limitation any implied warranties of merchantibility or fitness
  87.      for a particular purpose.  Citadel shall not be liable to anyone
  88.      for any special, incidental, consequential, indirect, or similar
  89.      damages due to loss of data or any other reason, even if Citadel
  90.      or an agent of Citadel has been advised of the possibility of
  91.      such damages.
  92.  
  93. ======================================================================
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.                                                         Citadel  89-10
  105. INSTALLATION INSTRUCTIONS
  106.  
  107. Exact installation procedures for MS-DOS vary.  These instructions are
  108. written for Borland Turbo C.
  109.  
  110.                             UNIX
  111.      1. Compile manx.
  112.              $ cc -O manx.c -o manx
  113.      2. Place manx in a directory in the path.
  114.              $ su
  115.              # mv manx /usr/bin
  116.              # ^D
  117.      3. Extract and print manx manual entry.
  118.              $ cat manx.c | manx > manx.man
  119.              $ lp manx.man
  120.  
  121.                            MS-DOS
  122.      1. Compile manx.
  123.              > tcc -O -mt manx.c
  124.      2. Place manx in a directory in the path.
  125.              > copy manx.exe \bin
  126.      3. Extract and print manx manual entry.
  127.              > type manx.c | manx > manx.man
  128.              > print manx.man
  129.  
  130. ======================================================================
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.                                                         Citadel  89-10
  157. ----------------------------------------------------------------------
  158. | cbase - C database library                                         |
  159. | Version 1.0                                                        |
  160. ----------------------------------------------------------------------
  161.  
  162. cbase is a C database file management library.  B+-trees are used for
  163. indexed and sequential record access.  cbase features a truly modular
  164. design and provides a logical and consistent interface.  The figure
  165. below shows the individual libraries included with cbase and their
  166. relationships.  Each of these is complete and may be used
  167. independently.
  168.  
  169.                  -----------------------------------
  170.                  |              cbase              |
  171.                  -----------------------------------
  172.                          |                 |
  173.                  ----------------- -----------------
  174.                  |     lseq      | |     btree     |
  175.                  ----------------- -----------------
  176.                          |                 |
  177.                  -----------------------------------
  178.                  |              blkio              |
  179.                  -----------------------------------
  180.  
  181.                     cbase and Underlying Libraries
  182.  
  183.      cbase - C database library
  184.      btree - B+-tree file management library
  185.      lseq  - doubly linked sequential file management library
  186.      blkio - block buffered input/output library
  187.  
  188. Extremely portable:
  189.   - Written in strict adherence to ANSI C standard.
  190.   - K&R C compatibility maintained.
  191.   - All operating system dependent code is isolated to a small portion
  192.     of the blkio library to make porting to new systems easy.
  193.   - All source code is included.
  194.   - UNIX and MS-DOS currently supported.*
  195. Completely buffered:
  196.   - Both records and indexes are buffered using LRU (least recently
  197.     used) buffering.
  198. Fast and efficient sequential access:
  199.   - Records are stored in doubly linked lists for non-keyed sequential
  200.     access.
  201.   - Indexes are stored in B+-trees to allow keyed sequential access.
  202.   - Both types of sequential access are bidirectional.
  203. Fast and efficient random access:
  204.   - B+-trees are used for inverted file key storage.
  205.   - Multiple keys are supported.
  206.   - Both unique and duplicate keys are supported.
  207.  
  208.                                                         Citadel  89-10
  209. Multiuser:
  210.   - Read-only locking.
  211. Other:
  212.   - Easy to add custom data types.
  213.   - Printable file data import and export.
  214.   - Marker used to detect corrupt files when opened.
  215.   - Reference documentation is in standard UNIX manual entry format,
  216.     including errno values.
  217.  
  218. All source code included.
  219. No run-time fees or royalties.
  220. Free technical support.
  221.  
  222. Price:  $77.00 + shipping
  223.  
  224. cbase may be downloaded from the Citadel BBS 317-647-2403.
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258. * UNIX is a trademark of AT&T.  MS-DOS is a trademark of Microsoft.
  259.  
  260.                                                         Citadel  89-10
  261.